/**
 * Copyright 2008 Matthew DeLambo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.delambo.drool.interfaces;

/**
 * Resource for pool nodes that encapsulates a resource and takes care of logic.
 * @author delambo
 * @param T type of encapsulated resource.
 */
public interface Resource<T> {

    interface Factory<T> {
        Resource create(T t, boolean validationValue); 
    }
    
    /**
     * Returns the encapsulated resource.
     * @return binded resource.
     */
    public T getResource();
    
    /**
     * Does all cleanup work to remove or finalize the encapsulated resource.
     */
    public void kill();
    
    /**
     * Runs validation on the encapsulated resource.
     * @return true if validation passes.
     */
    public boolean validate();
    
    /**
     * Does any cleanup work for the encapsulated resource.
     */
    public void clean();
}
